home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / bbs / wg961014.zip / PATCH.ZIP / PATCH.DOC next >
Text File  |  1996-10-14  |  5KB  |  142 lines

  1.  
  2.      W...W
  3.      W.W.W
  4.      .W.W.
  5.  
  6.      WaterGate
  7.      Message processor for FidoNet & Internet/Usenet
  8.      Patching instructions
  9.  
  10.      (c) Copyright 1993-1996 Waterline Software Development
  11.                              All Rights Reserved
  12.  
  13.  
  14. 14 October 1996
  15.  
  16. This document explains how patch files for WaterGate work, how you
  17. can get them and how to apply them.
  18.  
  19.  
  20. About patches
  21. -------------
  22.  
  23. If a small bug has been fixed in for example wtrgate.exe, then I
  24. don't have to release a new version and I neither have to send
  25. everybody a new executable of over 300kB.
  26.  
  27. Instead, I create a so call "patch" file that can be used to upgrade
  28. wtrgate.exe to the new version. The patch file must be applied with
  29. the program UNDIF.EXE that can be found in the distribution archive.
  30.  
  31. The patch file is a binary file with the extension .DIF. It contains
  32. a list of all the changes that have to be made to the current
  33. wtrgate.exe to get the new one. This is basically a list of "copy
  34. this part, modify that byte, move this here, move that there" and
  35. so on.
  36.  
  37. The patch file must always be applied to the correct version of the
  38. executable. I always state in the upgrade.doc that accompanies the
  39. .DIF file to which .exe file you have to apply the patch. Most of
  40. the time this will be the latest version. If I release patch 1,
  41. you have to apply it to the .exe file from the distribution archive.
  42. If I release patch 2, you have to apply it to the patch 1 executable.
  43.  
  44. The patches are called P1, P2, P3 and so on and the version numbers
  45. change accordingly: from 0.92 to 0.92.p1, 0.92.p2 and so on. The
  46. distribution archives for the patches are names wg<version>P<patch>,
  47. for example wg091p1.zip for patch level 1 for WaterGate version 0.91.
  48. The files inside the patch archive are always called wtrgate.dif for
  49. wtrgate.exe, wtrutil.dif for wtrutil.exe and so on.
  50.  
  51. The patches not always upgrade all the executables. Some only upgrade
  52. wtrgate.exe other upgrade wtrconf.exe and wtrutil.exe as well.
  53. Special patches for WtrConf, wtrUtil and WtrTest are named wc, wu
  54. and wt instead of wg. For example wu090p8, which only upgraded
  55. WtrUtil. Patches can upgrade the helpfile (wtrgate.hlp) as well.
  56. This patch is mostly call wtrhelp.dif. The .ovr file has wgovr.dif.
  57.  
  58.  
  59. Where can I get the patch files?
  60. --------------------------------
  61.  
  62. You should be able to find the patch files in the same place where
  63. you found WaterGate. Check getnew.doc for the hottest places on
  64. earth. People having WaterGate on-line for file request are kindly
  65. asked to allow the patches to be requested by their original
  66. filename.
  67.  
  68. As a last resort, you can always get the patches from me via e-mail
  69. by sending a message to <patch archive name>-req@wsd.wline.se, for
  70. example wg090p1-req@wsd.wline.se. Sometimes the patches are so big
  71. that I do not appreciate it if loads of people request it over
  72. my UUCP dial-up connection. If the patch is small, I don't care.
  73.  
  74.  
  75. How do I know there is a new patch?
  76. -----------------------------------
  77.  
  78. Subscribe to the announcement mailing list WaterGate. Send a message
  79. to listserv@wsd.wline.se and put nothing in the body except
  80. "connect watergate" (without the quotes) and you are certain to get
  81. an e-mail when I release a new version or a patch.
  82.  
  83.  
  84. How to apply a patch
  85. --------------------
  86.  
  87. When you have received a patch, you unzip the archive and find at
  88. least two files: one upgrade.doc which you must read very carefully
  89. and one or more .dif files.
  90.  
  91. Read the upgrade.doc to find out which executables to upgrade and
  92. copy these in a new directory. Also copy the .dif files and the
  93. program undif.exe into that same directory. Then, type the following
  94. command to start the patching process:
  95.  
  96. UNDIF *
  97.  
  98. The undif program will now search for all .DIF file, check the
  99. executable for the correct version and then apply the patch. The
  100. executable is not renamed but keeps its original name. No backup
  101. is made either.
  102.  
  103. When all executables have been patched successfully, you should
  104. not just copy them in place and run them. First make a backup
  105. of your WaterGate directory. Make sure to backup the executables
  106. and the database file, so you can always return to an older
  107. version if the need would arise.
  108.  
  109. When you have made the backup, then copy the new executables into
  110. the WaterGate directory.
  111.  
  112.  
  113. Upgrading databases
  114. -------------------
  115.  
  116. Some patches come with an upgrade.exe program which upgrades your
  117. database files (*.tdb) as well. If so, you have to run this program
  118. first before you can use the new executables. If you run more than
  119. one configuration (in different directories), then make sure you run
  120. upgrade.exe in each of these directories to upgrade all the
  121. database files.
  122.  
  123. Before you continue, go back to upgrade.doc to see if the changes
  124. made to the executables or databases might impact your system and
  125. you perhaps need to make other changes.
  126.  
  127. You are now ready to run the new executables. First run each of
  128. the executables to make sure they function and don't crash your
  129. system.
  130.  
  131. If everything seems OK, then start to test the new changes that
  132. were made. You have successfully patched your WaterGate system!
  133.  
  134. Mail me if you have any questions or comments to this document.
  135.  
  136. Ramon
  137.  
  138. ramon@wsd.wline.se
  139. ramon.vanderwinkel@ecs.ericsson.se
  140.  
  141.  
  142.